home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 3: The Continuation / 17-Bit_The_Continuation_Disc.iso / amigan / amigan 3 / unix / ckaaaa.hlp next >
Text File  |  1994-01-27  |  3KB  |  100 lines
  1. C-Kermit File Naming Conventions:
  2.  
  3. (Version 4D, 29 April 1986)
  4.  
  5. File names will be lowercase on Unix systems, and probably will be uppercase
  6. on other systems.  C-Kermit file names are of the form:
  7.  
  8. ck<system><what>.<type>
  9.  
  10. where:
  11.  
  12. <type> is the file type:
  13.  
  14.   c:   C language source
  15.   h:   Header file for C language source
  16.   w:   Wart preprocessor source, converted by Wart (or Lex) to a C program
  17.   nr:  Nroff/Troff text formatter source
  18.   mss: Scribe text formatter source
  19.   doc: Documentation
  20.   hlp: Help text
  21.   upd: Program change log
  22.   bwr: A "beware" file - list of known bugs, restrictions
  23.   ann: The text of an announcement of a particular version
  24.   bld: Instructions for building
  25.   mak: A Makefile or other build procedure (rename to "makefile" for UNIX)
  26.   com: (VMS only) a DCL command procedure
  27.  
  28. <system> is a single character to tell what system the file applies to:
  29.  
  30.   a: Descriptive material, documentation
  31.   c: All systems with C compilers
  32.   i: Commodore Amiga (Intuition)
  33.   m: Macintosh
  34.   u: Unix or systems that simulate (some features of) Unix
  35.   v: VAX/VMS
  36.   w: Wart (really belongs in 'c' category, but...)
  37.  
  38. <what> is mnemonic (up to 3 characters) for what's in the file
  39.  
  40.   aaa: A "read-me" file, like this one
  41.   cmd: Command parsing
  42.   con: Connect command
  43.   deb: Debug/Transaction Log formats, Typedefs
  44.   dia: Modem/Dialer control
  45.   fio: System-depdendent File I/O
  46.   fns: Protocol support functions
  47.   fn2: More protocol support functions
  48.   ker: General C-Kermit definitions, information, documentation
  49.   mai: Main program
  50.   pro: Protocol
  51.   scr: Script command
  52.   tio: System-dependent terminal i/o & control and interrupt handing
  53.   usr: User interface
  54.   us2: More user interface
  55.   us3: Still more user interface
  56.  
  57. Examples:
  58.  
  59. ckaaaa.hlp - This file
  60. ckufio.c   - File i/o for Unix
  61. ckmtio.c   - Terminal i/o for Macintosh
  62. ckuker.mss - Scribe source for for Unix C-Kermit Kermit User Guide chapter
  63. ckuker.nr  - Nroff source file for Unix C-Kermit man page
  64. ckuker.mak - Makefile for building Unix C-Kermit (rename to makefile)
  65. ckmker.mak - Makefile for building Macintosh C-Kermit under Unix/SUMACC
  66.  
  67. Macintosh Kermit adds a few additional items to this list:
  68.  
  69. <type>
  70.  
  71.   hqx: binhex'd Macintosh resource (binhex version 4)
  72.   sed: sed script for massaging ckcpro.c to make it smaller
  73.   rc:  rmaker input file (text)
  74.   rsrc: (or rsr) 8-bit binary Macintosh resource
  75.  
  76. <what>
  77.  
  78.   def: Macintosh definitions header
  79.   key: key redefinition package
  80.   ke2: more key redefinition package
  81.   ke3: still more key redefinition package
  82.   kkc: common defs between ckmkey and ckmker
  83.   rem: remote server command module
  84.   res: resource info
  85.   sav: settings saver module
  86.   scr: screen (conflicts with name of script module, should be changed)
  87.   sfp: standard file package
  88.   sum: sumacc workarounds
  89.   utl: utilities
  90.  
  91. All the files necessary to build a particular implementation of C-Kermit
  92. are listed in the appropriate makefile or equivalent:
  93.  
  94.      Unix: ckuker.mak
  95. Macintosh: ckmker.mak
  96.   VAX/VMS: ckvker.com
  97.     Amiga: ckiker.mak
  98.  
  99. (end of ckaaaa.hlp)
  100.